Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 11, 2025

Link issues

fixes #6014

Summary By Copilot

This pull request introduces a new feature to enable keyboard navigation in Excel mode for the Table component in the BootstrapBlazor library. It includes updates to the component's Razor file, JavaScript file, and unit tests to support this functionality.

Feature: Enable Keyboard Navigation in Excel Mode

Changes in Razor Component (Table.razor.cs):

  • Added a new parameter EnableKeyboardNavigationCell with a default value of true to control whether keyboard navigation is enabled in Excel mode.
  • Updated the OnTableRenderAsync method to pass the EnableKeyboardNavigationCell parameter to the table's configuration.

Changes in JavaScript (Table.razor.js):

  • Modified the reset and destroyTable functions to check the enableKeyboardNavigationCell option before attaching or detaching keyboard event listeners, ensuring the behavior respects the new parameter. [1] [2]

Unit Test Updates (TableTest.cs):

  • Added a test case to verify that the EnableKeyboardNavigationCell parameter can be set and functions correctly in Excel mode.

These changes enhance the usability of the Table component by allowing developers to enable or disable keyboard navigation in Excel mode as needed.

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Introduce a configurable parameter to enable or disable keyboard navigation in Excel mode for the Table component, updating component logic and tests accordingly.

New Features:

  • Add EnableKeyboardNavigationCell parameter to Table component to control keyboard navigation in Excel mode.

Enhancements:

  • Update Table component and JavaScript logic to respect the EnableKeyboardNavigationCell setting.

Tests:

  • Add unit test to verify EnableKeyboardNavigationCell functionality in Excel mode.

@bb-auto bb-auto bot added the enhancement New feature or request label May 11, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 11, 2025

Reviewer's Guide

This pull request introduces a new EnableKeyboardNavigationCell parameter to the Table component, allowing developers to enable or disable keyboard navigation in Excel mode. The implementation updates the Table's Razor and JavaScript files to respect this parameter and adds a corresponding unit test.

File-Level Changes

Change Details Files
Added EnableKeyboardNavigationCell parameter to Table component and integrated it into the component's configuration.
  • Introduced EnableKeyboardNavigationCell parameter with default true.
  • Passed the parameter to the table's configuration in OnTableRenderAsync.
src/BootstrapBlazor/Components/Table/Table.razor.cs
Updated JavaScript logic to conditionally attach/detach keyboard event listeners based on EnableKeyboardNavigationCell.
  • Modified reset and destroyTable functions to check enableKeyboardNavigationCell before handling keyboard events.
src/BootstrapBlazor/Components/Table/Table.razor.js
Added a unit test to verify EnableKeyboardNavigationCell functionality in Excel mode.
  • Added test case to set and check EnableKeyboardNavigationCell in Excel mode.
test/UnitTest/Components/TableTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6014 Add a parameter EnableKeyboardNavigationCell to the Table component to control keyboard navigation in Excel mode.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added this to the v9.6.0 milestone May 11, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We encountered an error and are unable to review this PR. We have been notified and are working to fix it.

You can try again by commenting this pull request with @sourcery-ai review, or contact us for help.

@codecov
Copy link

codecov bot commented May 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (0a920d3) to head (fe3ca1f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6015   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          670       670           
  Lines        30651     30653    +2     
  Branches      4362      4362           
=========================================
+ Hits         30651     30653    +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang merged commit 316eca5 into main May 11, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-excel branch May 11, 2025 02:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(Table): add EnableKeyboardNavigationCell parameter

2 participants